Description | Example | Return Message | Group(s)

SCHED: GetTaskInfo

Format

SCHED / GetTaskInfo '<TaskName>' '<FileName>'

Description

The SCHED GetTaskInfo Connect command returns all of the attributes of the task specified by the <TaskName> parameter.

Parameters

  • TaskName: The parameter is a string of text in single quotes of a comma delimited list of tasks. Task names should not be in quotes. Supports the use of wildcards.
  • FileName: The parameter is a string of text in single quotes of the absolute path file name. Empty string is allowed if the command does not write out to a file.

Examples

Finds out the values of all the attributes of the SSRDump task in the active schedule and saves it to the file "out.txt" located at "C:\Outputs\"
SCHED / GetTaskInfo 'SSRDump' 'C:\Outputs\out.txt'

SyntaxExample
<CommandName>SCHED / GetTaskInfo
<TaskName>'SSRDump'
<FileName>'C:\Outputs\out.txt'

Return Message

Connect returns a message that contains all of the attribute data for the task. The report matches the format specified on the Task Report page.


Group Membership

This command belongs to the following group(s):

Scheduler

Version

4.3.1 and 5.0